<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::NegativeAUC&lt; LabelType, OutputType &gt; Class Template Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_negative_a_u_c.html">NegativeAUC</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_negative_a_u_c-members.html">List of all members</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle"><div class="title">shark::NegativeAUC&lt; LabelType, OutputType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__costfunctions.html">Cost functions</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Negative area under the curve.  
 <a href="classshark_1_1_negative_a_u_c.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_negative_a_u_c_8h_source.html">shark/ObjectiveFunctions/NegativeAUC.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::NegativeAUC&lt; LabelType, OutputType &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classshark_1_1_negative_a_u_c__inherit__graph.png" border="0" usemap="#ashark_1_1_negative_a_u_c_3_01_label_type_00_01_output_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_negative_a_u_c_3_01_label_type_00_01_output_type_01_4_inherit__map" id="ashark_1_1_negative_a_u_c_3_01_label_type_00_01_output_type_01_4_inherit__map">
<area shape="rect" title="Negative area under the curve." alt="" coords="5,94,185,135"/>
<area shape="rect" href="classshark_1_1_abstract_cost.html" title="Cost function interface." alt="" coords="26,5,164,46"/>
<area shape="poly" title=" " alt="" coords="98,62,98,94,92,94,92,62"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aaaca27d1a2b3d4d5350aa3689ba3b869" id="r_aaaca27d1a2b3d4d5350aa3689ba3b869"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structshark_1_1_key_value_pair.html">KeyValuePair</a>&lt; double, <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#aaaca27d1a2b3d4d5350aa3689ba3b869">AUCPair</a></td></tr>
<tr class="separator:aaaca27d1a2b3d4d5350aa3689ba3b869"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classshark_1_1_abstract_cost"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classshark_1_1_abstract_cost')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classshark_1_1_abstract_cost.html">shark::AbstractCost&lt; LabelT, OutputT &gt;</a></td></tr>
<tr class="memitem:a3f2ae17818520465f0e73257fd202bac inherit pub_types_classshark_1_1_abstract_cost" id="r_a3f2ae17818520465f0e73257fd202bac"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bac">Feature</a> { <a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bacad1e0927ebd68caf428c52cc4cecc084a">HAS_FIRST_DERIVATIVE</a> = 1
, <a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202baca757525584b3fc0a7aa977255fd6d8232">HAS_SECOND_DERIVATIVE</a> = 2
, <a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bacaaa945f1c8fb58952a4dbea1a1ff86231">IS_LOSS_FUNCTION</a> = 4
 }</td></tr>
<tr class="memdesc:a3f2ae17818520465f0e73257fd202bac"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of features a cost function can have  <a href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bac">More...</a><br /></td></tr>
<tr class="separator:a3f2ae17818520465f0e73257fd202bac inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad35be71a61620930c1b6c44aecb7c33 inherit pub_types_classshark_1_1_abstract_cost" id="r_aad35be71a61620930c1b6c44aecb7c33"><td class="memItemLeft" align="right" valign="top">typedef OutputT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a></td></tr>
<tr class="separator:aad35be71a61620930c1b6c44aecb7c33 inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0d1c0437931e46d5b6192b214bc6f59 inherit pub_types_classshark_1_1_abstract_cost" id="r_aa0d1c0437931e46d5b6192b214bc6f59"><td class="memItemLeft" align="right" valign="top">typedef LabelT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a></td></tr>
<tr class="separator:aa0d1c0437931e46d5b6192b214bc6f59 inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34c29a41e3dc317b2c97a49e2dbe5da4 inherit pub_types_classshark_1_1_abstract_cost" id="r_a34c29a41e3dc317b2c97a49e2dbe5da4"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structshark_1_1_batch.html">Batch</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a34c29a41e3dc317b2c97a49e2dbe5da4">BatchOutputType</a></td></tr>
<tr class="separator:a34c29a41e3dc317b2c97a49e2dbe5da4 inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae76592e18c367f68e9456e76acc35c03 inherit pub_types_classshark_1_1_abstract_cost" id="r_ae76592e18c367f68e9456e76acc35c03"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structshark_1_1_batch.html">Batch</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt;::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#ae76592e18c367f68e9456e76acc35c03">BatchLabelType</a></td></tr>
<tr class="separator:ae76592e18c367f68e9456e76acc35c03 inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65e8014268b6aa7215900d43a291eae5 inherit pub_types_classshark_1_1_abstract_cost" id="r_a65e8014268b6aa7215900d43a291eae5"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_typed_flags.html">TypedFlags</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bac">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a65e8014268b6aa7215900d43a291eae5">Features</a></td></tr>
<tr class="separator:a65e8014268b6aa7215900d43a291eae5 inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24a1a53503c39eeeae1d7b3d43fd120f inherit pub_types_classshark_1_1_abstract_cost" id="r_a24a1a53503c39eeeae1d7b3d43fd120f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_typed_feature_not_available_exception.html">TypedFeatureNotAvailableException</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#a3f2ae17818520465f0e73257fd202bac">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a24a1a53503c39eeeae1d7b3d43fd120f">FeatureNotAvailableException</a></td></tr>
<tr class="separator:a24a1a53503c39eeeae1d7b3d43fd120f inherit pub_types_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8589cb24e741e1934af4a704ec3dd7dc" id="r_a8589cb24e741e1934af4a704ec3dd7dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#a8589cb24e741e1934af4a704ec3dd7dc">NegativeAUC</a> (bool invert=false)</td></tr>
<tr class="separator:a8589cb24e741e1934af4a704ec3dd7dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f47bfe33018e018d4b82dbe03caa3c2" id="r_a9f47bfe33018e018d4b82dbe03caa3c2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#a9f47bfe33018e018d4b82dbe03caa3c2">name</a> () const</td></tr>
<tr class="memdesc:a9f47bfe33018e018d4b82dbe03caa3c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">From <a class="el" href="classshark_1_1_i_nameable.html" title="This class is an interface for all objects which can have a name.">INameable</a>: return the class name.  <br /></td></tr>
<tr class="separator:a9f47bfe33018e018d4b82dbe03caa3c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5265a1b04657e60004f9a681027cfea4" id="r_a5265a1b04657e60004f9a681027cfea4"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#a5265a1b04657e60004f9a681027cfea4">eval</a> (<a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; const &amp;target, <a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt; const &amp;prediction, unsigned int column) const</td></tr>
<tr class="memdesc:a5265a1b04657e60004f9a681027cfea4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes area under the curve.  <br /></td></tr>
<tr class="separator:a5265a1b04657e60004f9a681027cfea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a969990014ff8964d6e67fcf72318b02b" id="r_a969990014ff8964d6e67fcf72318b02b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#a969990014ff8964d6e67fcf72318b02b">eval</a> (<a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; const &amp;target, <a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt; const &amp;prediction) const</td></tr>
<tr class="memdesc:a969990014ff8964d6e67fcf72318b02b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes area under the curve. If the prediction vector is 1-dimensional, the "positive" class is mapped to larger values. If the prediction vector is 2-dimensional, the second dimension is viewed as the "positive" class. For higher dimensional vectors, an exception is thrown. In such a case, the column has to be explicitly specified as an additional parameter.  <br /></td></tr>
<tr class="separator:a969990014ff8964d6e67fcf72318b02b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_abstract_cost"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_abstract_cost')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_abstract_cost.html">shark::AbstractCost&lt; LabelT, OutputT &gt;</a></td></tr>
<tr class="memitem:a08169d91360192c906792ffe9a07f14f inherit pub_methods_classshark_1_1_abstract_cost" id="r_a08169d91360192c906792ffe9a07f14f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a08169d91360192c906792ffe9a07f14f">~AbstractCost</a> ()</td></tr>
<tr class="separator:a08169d91360192c906792ffe9a07f14f inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade575e40884a417f5afa3e1a67ec9086 inherit pub_methods_classshark_1_1_abstract_cost" id="r_ade575e40884a417f5afa3e1a67ec9086"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classshark_1_1_abstract_cost.html#a65e8014268b6aa7215900d43a291eae5">Features</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#ade575e40884a417f5afa3e1a67ec9086">features</a> () const</td></tr>
<tr class="separator:ade575e40884a417f5afa3e1a67ec9086 inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34f65782895f7d2018970e3f961f19f7 inherit pub_methods_classshark_1_1_abstract_cost" id="r_a34f65782895f7d2018970e3f961f19f7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a34f65782895f7d2018970e3f961f19f7">updateFeatures</a> ()</td></tr>
<tr class="separator:a34f65782895f7d2018970e3f961f19f7 inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aef444b7ef11ba6b31c8b2b0a9c24c8 inherit pub_methods_classshark_1_1_abstract_cost" id="r_a5aef444b7ef11ba6b31c8b2b0a9c24c8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a5aef444b7ef11ba6b31c8b2b0a9c24c8">hasFirstDerivative</a> () const</td></tr>
<tr class="memdesc:a5aef444b7ef11ba6b31c8b2b0a9c24c8 inherit pub_methods_classshark_1_1_abstract_cost"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns true when the first parameter derivative is implemented  <br /></td></tr>
<tr class="separator:a5aef444b7ef11ba6b31c8b2b0a9c24c8 inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9a59d0fffd49c260995c05820723029 inherit pub_methods_classshark_1_1_abstract_cost" id="r_aa9a59d0fffd49c260995c05820723029"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#aa9a59d0fffd49c260995c05820723029">isLossFunction</a> () const</td></tr>
<tr class="memdesc:aa9a59d0fffd49c260995c05820723029 inherit pub_methods_classshark_1_1_abstract_cost"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns true when the cost function is in fact a loss function  <br /></td></tr>
<tr class="separator:aa9a59d0fffd49c260995c05820723029 inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab299a1d05b8592018de7df84c1928d42 inherit pub_methods_classshark_1_1_abstract_cost" id="r_ab299a1d05b8592018de7df84c1928d42"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#ab299a1d05b8592018de7df84c1928d42">operator()</a> (<a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; const &amp;targets, <a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt; const &amp;predictions) const</td></tr>
<tr class="separator:ab299a1d05b8592018de7df84c1928d42 inherit pub_methods_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_i_nameable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_i_nameable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_i_nameable.html">shark::INameable</a></td></tr>
<tr class="memitem:a877dbdfc6b58ea836495143cea44a98c inherit pub_methods_classshark_1_1_i_nameable" id="r_a877dbdfc6b58ea836495143cea44a98c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_nameable.html#a877dbdfc6b58ea836495143cea44a98c">~INameable</a> ()</td></tr>
<tr class="separator:a877dbdfc6b58ea836495143cea44a98c inherit pub_methods_classshark_1_1_i_nameable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a336caed340dd3d3c82e7149091ce0977" id="r_a336caed340dd3d3c82e7149091ce0977"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#a336caed340dd3d3c82e7149091ce0977">trapArea</a> (double x1, double x2, double y1, double y2) const</td></tr>
<tr class="separator:a336caed340dd3d3c82e7149091ce0977"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac8ee356a559d98706eeaf115a6affe6d" id="r_ac8ee356a559d98706eeaf115a6affe6d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_negative_a_u_c.html#ac8ee356a559d98706eeaf115a6affe6d">m_invert</a></td></tr>
<tr class="separator:ac8ee356a559d98706eeaf115a6affe6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classshark_1_1_abstract_cost"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classshark_1_1_abstract_cost')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classshark_1_1_abstract_cost.html">shark::AbstractCost&lt; LabelT, OutputT &gt;</a></td></tr>
<tr class="memitem:a97902a8a75733642a4472b463ae9b7dc inherit pro_attribs_classshark_1_1_abstract_cost" id="r_a97902a8a75733642a4472b463ae9b7dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_abstract_cost.html#a65e8014268b6aa7215900d43a291eae5">Features</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_cost.html#a97902a8a75733642a4472b463ae9b7dc">m_features</a></td></tr>
<tr class="separator:a97902a8a75733642a4472b463ae9b7dc inherit pro_attribs_classshark_1_1_abstract_cost"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> = RealVector&gt;<br />
class shark::NegativeAUC&lt; LabelType, OutputType &gt;</div><p>Negative area under the curve. </p>
<p>This class computes the area under the <a class="el" href="classshark_1_1_r_o_c.html" title="ROC-Curve - false negatives over false positives.">ROC</a> (receiver operating characteristic) curve. It implements the algorithm described in: Tom Fawcett. <a class="el" href="classshark_1_1_r_o_c.html" title="ROC-Curve - false negatives over false positives.">ROC</a> Graphs: Notes and Practical Considerations for Researchers. 2004</p>
<p>The area is negated so that optimizing the AUC corresponds to a minimization task. </p>

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00052">52</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aaaca27d1a2b3d4d5350aa3689ba3b869" name="aaaca27d1a2b3d4d5350aa3689ba3b869"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaaca27d1a2b3d4d5350aa3689ba3b869">&#9670;&#160;</a></span>AUCPair</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structshark_1_1_key_value_pair.html">KeyValuePair</a>&lt; double, <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::AUCPair</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00055">55</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8589cb24e741e1934af4a704ec3dd7dc" name="a8589cb24e741e1934af4a704ec3dd7dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8589cb24e741e1934af4a704ec3dd7dc">&#9670;&#160;</a></span>NegativeAUC()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::NegativeAUC </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>invert</em> = <code>false</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">invert</td><td>if set to true, the role of positive and negative class are switched </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00059">59</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_negative_a_u_c.html#ac8ee356a559d98706eeaf115a6affe6d">shark::NegativeAUC&lt; LabelType, OutputType &gt;::m_invert</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a969990014ff8964d6e67fcf72318b02b" name="a969990014ff8964d6e67fcf72318b02b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a969990014ff8964d6e67fcf72318b02b">&#9670;&#160;</a></span>eval() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::eval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; const &amp;&#160;</td>
          <td class="paramname"><em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt; const &amp;&#160;</td>
          <td class="paramname"><em>prediction</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Computes area under the curve. If the prediction vector is 1-dimensional, the "positive" class is mapped to larger values. If the prediction vector is 2-dimensional, the second dimension is viewed as the "positive" class. For higher dimensional vectors, an exception is thrown. In such a case, the column has to be explicitly specified as an additional parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">target</td><td>class label, 0 or 1 </td></tr>
    <tr><td class="paramname">prediction</td><td>prediction by classifier, OutputType-valued vector </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classshark_1_1_abstract_cost.html#ab59cf559ad6f04d07752ffdcda155723">shark::AbstractCost&lt; LabelT, OutputT &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00130">130</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

<p class="reference">References <a class="el" href="group__shark__globals.html#ga6231b46b09731352a3cac40709a9625f">shark::dataDimension()</a>, <a class="el" href="classshark_1_1_negative_a_u_c.html#a5265a1b04657e60004f9a681027cfea4">shark::NegativeAUC&lt; LabelType, OutputType &gt;::eval()</a>, <a class="el" href="group__shark__globals.html#ga814e8b0028cc90dd2af69805e8f8a04d">shark::Data&lt; Type &gt;::numberOfElements()</a>, and <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>.</p>

</div>
</div>
<a id="a5265a1b04657e60004f9a681027cfea4" name="a5265a1b04657e60004f9a681027cfea4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5265a1b04657e60004f9a681027cfea4">&#9670;&#160;</a></span>eval() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::eval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a> &gt; const &amp;&#160;</td>
          <td class="paramname"><em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classshark_1_1_data.html">Data</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt; const &amp;&#160;</td>
          <td class="paramname"><em>prediction</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>column</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Computes area under the curve. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">target</td><td>class label, 0 or 1 </td></tr>
    <tr><td class="paramname">prediction</td><td>prediction by classifier, OutputType-valued vector </td></tr>
    <tr><td class="paramname">column</td><td>indicates the column of the prediction vector interpreted as probability of positive class </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00071">71</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

<p class="reference">References <a class="el" href="group__shark__globals.html#ga6231b46b09731352a3cac40709a9625f">shark::dataDimension()</a>, <a class="el" href="group__shark__globals.html#ga0ea72a74a21d5ff59772516b83c4a58b">shark::Data&lt; Type &gt;::element()</a>, <a class="el" href="classshark_1_1_negative_a_u_c.html#ac8ee356a559d98706eeaf115a6affe6d">shark::NegativeAUC&lt; LabelType, OutputType &gt;::m_invert</a>, <a class="el" href="group__shark__globals.html#ga814e8b0028cc90dd2af69805e8f8a04d">shark::Data&lt; Type &gt;::numberOfElements()</a>, <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>, and <a class="el" href="classshark_1_1_negative_a_u_c.html#a336caed340dd3d3c82e7149091ce0977">shark::NegativeAUC&lt; LabelType, OutputType &gt;::trapArea()</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_negative_a_u_c.html#a969990014ff8964d6e67fcf72318b02b">shark::NegativeAUC&lt; LabelType, OutputType &gt;::eval()</a>.</p>

</div>
</div>
<a id="a9f47bfe33018e018d4b82dbe03caa3c2" name="a9f47bfe33018e018d4b82dbe03caa3c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f47bfe33018e018d4b82dbe03caa3c2">&#9670;&#160;</a></span>name()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::name </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>From <a class="el" href="classshark_1_1_i_nameable.html" title="This class is an interface for all objects which can have a name.">INameable</a>: return the class name. </p>

<p>Reimplemented from <a class="el" href="classshark_1_1_i_nameable.html#a9893f99314de30cd472e649c235d0db4">shark::INameable</a>.</p>

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00064">64</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

</div>
</div>
<a id="a336caed340dd3d3c82e7149091ce0977" name="a336caed340dd3d3c82e7149091ce0977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a336caed340dd3d3c82e7149091ce0977">&#9670;&#160;</a></span>trapArea()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::trapArea </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00143">143</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_negative_a_u_c.html#a5265a1b04657e60004f9a681027cfea4">shark::NegativeAUC&lt; LabelType, OutputType &gt;::eval()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac8ee356a559d98706eeaf115a6affe6d" name="ac8ee356a559d98706eeaf115a6affe6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8ee356a559d98706eeaf115a6affe6d">&#9670;&#160;</a></span>m_invert</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>  = unsigned int, class <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classshark_1_1_negative_a_u_c.html">shark::NegativeAUC</a>&lt; <a class="el" href="classshark_1_1_abstract_cost.html#aa0d1c0437931e46d5b6192b214bc6f59">LabelType</a>, <a class="el" href="classshark_1_1_abstract_cost.html#aad35be71a61620930c1b6c44aecb7c33">OutputType</a> &gt;::m_invert</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_negative_a_u_c_8h_source.html#l00149">149</a> of file <a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_negative_a_u_c.html#a5265a1b04657e60004f9a681027cfea4">shark::NegativeAUC&lt; LabelType, OutputType &gt;::eval()</a>, and <a class="el" href="classshark_1_1_negative_a_u_c.html#a8589cb24e741e1934af4a704ec3dd7dc">shark::NegativeAUC&lt; LabelType, OutputType &gt;::NegativeAUC()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/ObjectiveFunctions/<a class="el" href="_negative_a_u_c_8h_source.html">NegativeAUC.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
